Skip to main content

Ribbon How To's

How to's for the Ribbon guide.

How to Use Ribbon?​

How to Use Ribbon?​

The following steps should be followed to use the Ribbon object on a form.

Add the Ribbon Object to the Form​

  1. Open the form design screen
  2. Go to the Toolbox panel
  3. Locate the Ribbon object
  4. Drag and drop the object onto the form

The Ribbon will appear at the top of the form as a toolbar area.

Define the Ribbon Content​

When the Ribbon object is selected, the Property Viewer panel opens.
From here, you can configure the items to be added to the Ribbon.

Items that can be added to the Ribbon:

  • Action Buttons
  • Menu groups
  • Custom operation buttons

For each button, you can define:

  • Display text
  • Icon
  • Action to be triggered

What Is Ribbon?​

What Is Ribbon?​

The Ribbon is a form object that allows developers to design a custom toolbar on the form.
With this toolbar, users can easily perform various tasks on the form using buttons, menus, and actions.

The Ribbon structure is especially used in forms that involve a large number of operations, aiming to improve user experience, and make tasks more accessible and organized.

Key Features​

  • Acts as a command center located at the top of the form
  • Can contain:
    • Action Buttons
    • Menu groups
    • Custom operations
  • Provides one-click access to frequently used operations for users
  • Speeds up workflows and simplifies form usage

When Is It Used?​

The Ribbon object is preferred in the following scenarios:

  • When the form involves a large number of operations or actions
  • When quick access for the user is desired
  • When bulk actions are to be performed with objects like DataGrid, TreeList, etc.
  • When a desktop-like application experience is aimed

Example Use Cases​

  • Basic operations like Save / Delete / Update
  • Additional functions like Generate Report, Export to Excel
  • Operations like Start Process, Open Form, Execute Custom Action

How to Use Client Enabled?​

What is Client Enabled?​

Client Enabled is a property that defines whether a form control is active (enabled) on the client side when the form is first loaded.
If it is set to True, the control is immediately usable by the user.
If it is set to False, the control is disabled and cannot be interacted with until a specific condition or rule activates it.

This property is especially useful for controlling the user’s interaction flow and applying dynamic behaviors using the Rule Manager.

What Does It Do?​

The property allows developers to:

  • Control when a form control becomes interactive.
  • Prevent users from entering or changing data until prerequisites are met.
  • Dynamically enable or disable controls based on user input or logic.

Example Scenario — Conditional Activation​

Scenario:
A form contains a checkbox called “I Accept Terms” and a text field called “Signature.”
The goal is to make the “Signature” field inactive until the user checks “I Accept Terms.”

Steps to Implement:​

  1. Select the “Signature” field in the form editor.

  2. In the Properties panel, find the Client Enabled field.

  3. Set the value to False — the field will now be disabled by default when the form loads.

  4. Open the Rule Manager.

  5. Add a new rule:

    Condition:

Action:

  1. Save and publish the form.

Result:​

  • When the form loads, the “Signature” field is disabled.
  • Once the user checks “I Accept Terms,” the field automatically becomes active and editable.

Behavior Summary​

Property StateDescription
TrueThe control is active and ready for user interaction when the form loads.
FalseThe control is disabled at load time and can be enabled dynamically via rules or code.

Notes & Best Practices​

  • Use the Client Enabled property to manage client-side interactivity without requiring server actions.
  • Combine it with Rule Manager to define when and how controls become active.
  • Remember: if server enablement is disabled, the client cannot enable the control even if Client Enabled is set to True.
  • By default, this property is set to True (active).

Summary​

Client Enabled improves form usability by letting developers control when and how users interact with form controls.
It is essential for creating responsive, condition-based form experiences where user actions dynamically change the form’s state.